/*
 * ------------------------------------------------------------------------
 *
 *  Copyright by KNIME AG, Zurich, Switzerland
 *  Website: http://www.knime.com; Email: contact@knime.com
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME AG herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME. The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * ------------------------------------------------------------------------
 * 
 * History
 *   Mar 31, 2011 (wiswedel): created
 */
package org.knime.core.node.workflow.virtual.parchunk;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import org.knime.core.node.port.PortObject;
import org.knime.core.node.workflow.FlowVariable;

/**
 * Utility object that represents the output objects of virtual input nodes.
 * @author wiswedel, University of Konstanz
 */
public final class VirtualParallelizedChunkNodeInput {
	
	private final PortObject[] m_inputObjects;
	private final List<FlowVariable> m_flowVariables;
	private final int m_chunkIndex;
	/**
	 * @param inputObjects
	 * @param chunkIndex
	 */
	@SuppressWarnings("unchecked")
	public VirtualParallelizedChunkNodeInput(
			final PortObject[] inputObjects, final int chunkIndex) {
		this(inputObjects, Collections.EMPTY_LIST, chunkIndex);
	}
	
	/**
	 * @param inputObjects
	 * @param flowVariables
	 * @param chunkIndex
	 */
	public VirtualParallelizedChunkNodeInput(final PortObject[] inputObjects,
			final List<FlowVariable> flowVariables, final int chunkIndex) {
		if (Arrays.asList(inputObjects).contains(null)) {
			throw new NullPointerException("Null elements not allowed");
		}
		if (flowVariables.contains(null)) {
			throw new NullPointerException("Null elements not allowed");
		}
		if (chunkIndex < 0) {
			throw new IllegalArgumentException(
					"Illegal chunk index: " + chunkIndex);
		}
		m_inputObjects = inputObjects;
		m_flowVariables = flowVariables;
		m_chunkIndex = chunkIndex;
	}

	/**
	 * @return the inputObjects
	 */
	public PortObject[] getInputObjects() {
		return m_inputObjects;
	}
	/**
	 * @return the flowVariables
	 */
	public List<FlowVariable> getFlowVariables() {
		return m_flowVariables;
	}
	/**
	 * @return the chunkIndex
	 */
	public int getChunkIndex() {
		return m_chunkIndex;
	}
	

}
